/*
 * Copyright (c) 2010, VeRSI Consortium
 *   (Victorian eResearch Strategic Initiative, Australia)
 * All rights reserved.
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 *     * Redistributions of source code must retain the above copyright
 *       notice, this list of conditions and the following disclaimer.
 *     * Redistributions in binary form must reproduce the above copyright
 *       notice, this list of conditions and the following disclaimer in the
 *       documentation and/or other materials provided with the distribution.
 *     * Neither the name of the VeRSI, the VeRSI Consortium members, nor the
 *       names of its contributors may be used to endorse or promote products
 *       derived from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND ANY
 * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED. IN NO EVENT SHALL THE REGENTS AND CONTRIBUTORS BE LIABLE FOR ANY
 * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */
package versi.vitro.oaiserviceprovider.helper;

import java.io.File;

/**
 * General Utilities Helper.
 */
public interface GeneralHelper {

    /**
     * Gets a File as Byte Array.
     * 
     * @param file
     *            File object.
     * @return Array of bytes represents the content of the file.
     * */
    byte[] getFileAsByteArray(final File file);

    /**
     * Writes a byte array to local file.
     * 
     * @param fileByteArray
     *            Array of bytes represents of the content of the file to be
     *            written.
     * @param filePath
     *            Path of the file to be written.
     * 
     * */
    void writeByteArrayToLocalFile(final byte[] fileByteArray, final String filePath);

    /**
     * Gets a XSLT for transformation.
     * 
     * @param filePath
     *            File Path.
     * @return String A string representation of the given file path's content
     * */
    String readFileAsString(final String filePath);

    /**
     * Reads a classpath resource as string.
     * 
     * @param resourcePath
     *            Resource Path within the classpath.
     * @return String Resource contents.
     * */
    String readResourceAsString(final String resourcePath);

    /**
     * Reads a package resource as string.
     * 
     * @param resourcePath
     *            Resource Path within the classpath.
     * @param clazz
     * @return String Resource contents.
     * */
    @SuppressWarnings("unchecked")
    String readPackageResourceAsString(final String resourcePath, final Class clazz);

}
